home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / espnotify.z / espnotify
Encoding:
Text File  |  2001-04-17  |  13.1 KB  |  331 lines
  1.  
  2.  
  3.  
  4. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      espnotify - a generic command line notification utility for SGI Embedded
  10.      Support Partner
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ////uuuussssrrrr////bbbbiiiinnnn////eeeessssppppnnnnoooottttiiiiffffyyyy [[[[----nnnn priority ----dddd] -E <_e-_m_a_i_l _a_d_d_r_e_s_s_e_s> [----FFFF <_S_e_n_d_e_r _a_d_d_r_e_s_s>]
  14.                         { ----ffff <_f_i_l_e_n_a_m_e> | ----mmmm <_m_e_s_s_a_g_e> }
  15.                         [----oooo <_p_r_o_c_e_s_s_i_n_g _o_p_t_i_o_n_s>] [----ssss <_s_u_b_j_e_c_t>]
  16.  
  17.      ////uuuussssrrrr////bbbbiiiinnnn////eeeessssppppnnnnoooottttiiiiffffyyyy [[[[----nnnn priority ----dddd] -c <_m_e_s_s_a_g_e> [----aaaa] [----DDDD <_D_i_s_p_l_a_y>] [----gggg <_g_e_o_m_e_t_r_y>]
  18.                         [----iiii <_i_c_o_n _i_m_a_g_e>] [----tttt <_t_i_t_l_e>]
  19.  
  20.      ////uuuussssrrrr////bbbbiiiinnnn////eeeessssppppnnnnoooottttiiiiffffyyyy [[[[----nnnn priority ----dddd] -C <_m_e_s_s_a_g_e> ----pppp <_p_a_g_e_r_s> [----SSSS <_p_a_g_i_n_g _s_e_r_v_i_c_e>]
  21.                         [----QQQQ <_q_p_a_g_e _s_e_r_v_e_r>]
  22.  
  23.      ////uuuussssrrrr////bbbbiiiinnnn////eeeessssppppnnnnoooottttiiiiffffyyyy [[[[----nnnn priority ----dddd] -A <_m_e_s_s_a_g_e>
  24.  
  25. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.      _e_s_p_n_o_t_i_f_y is a generic command line utility that is packaged with SGI
  27.      Embedded Support Partner (see eeeesssspppp(5) for more details).  It is used to
  28.      perform various types of notifications.
  29.  
  30.      _e_s_p_n_o_t_i_f_y can post a given message to e-mail addresses, can display a
  31.      message on local/remote X display, can post a message to a paging service
  32.      to be delivered to a pager or can display the message on the system
  33.      console.
  34.  
  35.      _e_s_p_n_o_t_i_f_y supports various command line options for various types of
  36.      notifications.  These options are discussed in detail later in this man
  37.      page.  More than one type of notification can be specified at a time.
  38.      There are some general options that are applicable to all types of
  39.      notifications.  These general options are :
  40.  
  41.      ----dddd   This causes espnotify to display debug information.
  42.  
  43.      ----nnnn _r_a_n_g_e _f_r_o_m _1 _t_o _7
  44.           Provide a numeric priority for the message (defaults to 7).  The
  45.           priorities are decoded as follows :
  46.                     1 and 2   Critical Message
  47.                     3         Error Message
  48.                     4         Warning Message
  49.                     5 to 7    Informational Message
  50.  
  51.      The first synopsis is for posting a message to specified e-mail
  52.      addresses.  _e_s_p_n_o_t_i_f_y invokes /usr/sbin/Mail ( or /usr/lib/sendmail if -_F
  53.      command-line argument is used ) to deliver message to the e-mail
  54.      addresses specified with -_E option.
  55.  
  56.      The options for e-mail notification include:
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  71.  
  72.  
  73.  
  74.      ----EEEE _e-_m_a_i_l _a_d_d_r_e_s_s_e_s
  75.           Comma separated list of e-mail addresses for use in e-mail
  76.           notifications.  This option must be specified for e-mail
  77.           notification to work.
  78.  
  79.      ----FFFF _S_e_n_d_e_r _E_m_a_i_l _a_d_d_r_e_s_s
  80.           This is to override  ESP Customer Profile user-defined _S_e_n_d_e_r _E_m_a_i_l
  81.           _A_d_d_r_e_s_s value which is actually passed to espnotify as an
  82.           environment variable EEEESSSSPPPP____MMMMAAAAIIIILLLL____FFFFRRRROOOOMMMM.  If none of them are defined(or
  83.           empty), the sender is set to the current executing username.
  84.  
  85.      ----ffff _f_i_l_e_n_a_m_e
  86.           This specifies a text file content of which is used for e-mail
  87.           notification.  A binary file may be sent if the ----oooo option is used.
  88.  
  89.      ----mmmm _m_e_s_s_a_g_e
  90.           This option is used when the content for an email notification is to
  91.           be a string.  All strings must be enclosed in double quotes.  Please
  92.           note that ----mmmm and ----ffff options are mutually exclusive.
  93.  
  94.      ----oooo _p_r_o_c_e_s_s_i_n_g _o_p_t_i_o_n_s
  95.           Processing options for the message.  Supported options are _C_O_M_P
  96.           (compress and uuencode the message) and _E_N_C_O (uuencode the message).
  97.           Processing options are valid only with ----ffff option.
  98.  
  99.      ----ssss _s_u_b_j_e_c_t
  100.           Subject for the message.  In case no subject is given, a default
  101.           subject is provided by _e_s_p_n_o_t_i_f_y. The format of the default subject
  102.           is as follows :
  103.  
  104.               [HOSTNAME]: <text>
  105.  
  106.               where,
  107.               HOSTNAME is the name of the host
  108.               <text> can be "Critical System Error" or "System Error" or
  109.                      "System Warning" or "System Information" depending
  110.                      on priority.
  111.  
  112.           If both subject and priority are specified, the subject specified
  113.           with -s overrides the default subject.  If neither a subject or
  114.           priority is specified, the subject will default to "[HOSTNAME]:
  115.           System Information".
  116.  
  117.      The second synopsis is for displaying a message (graphical notification)
  118.      to a local/remote X display.
  119.  
  120.      The options for graphical notification include:
  121.  
  122.      ----aaaa   This options specifies that audio should be used along with
  123.           graphical notification.  Audio notification cannot be run without
  124.           graphical notification.  Audio is played via the /usr/sbin/ssplay
  125.           command on which host it is executed.  It is not possible to play
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  137.  
  138.  
  139.  
  140.           audio on a remote host.
  141.  
  142.      ----cccc _m_e_s_s_a_g_e
  143.           A text string for use as GUI notification content.  Text must be
  144.           contained within double quotes if spaces are needed in the string.
  145.           This option must be specified to perform a graphical notification.
  146.  
  147.      ----DDDD _D_i_s_p_l_a_y
  148.           Specifies an alternate display host on which to display a graphical
  149.           notification.  The default is to display on the host specified in
  150.           the $DISPLAY environment variable.
  151.  
  152.      ----gggg _g_e_o_m_e_t_r_y
  153.           X compatible geometry string in the form WIDTHxHEIGHT+XOFF+YOFF
  154.           where WIDTH, HEIGHT, XOFF, and YOFF are numbers) for specifying a
  155.           preferred size and location for this application's main window.
  156.  
  157.      ----iiii _i_c_o_n _i_m_a_g_e
  158.           This option specifies the icon to display within graphical
  159.           notifications.
  160.  
  161.           There are four options:
  162.  
  163.                _CCCC_rrrr_iiii_tttt_iiii_cccc_aaaa_llll
  164.                _EEEE_rrrr_rrrr_oooo_rrrr
  165.                _WWWW_aaaa_rrrr_nnnn_iiii_nnnn_gggg
  166.                _IIII_nnnn_ffff_oooo
  167.  
  168.           If a priority is set with the -n option, the icon is set
  169.           accordingly.  If neither priority or icon_image is specified, the
  170.           "Info" icon will be defaulted to.
  171.  
  172.      ----tttt _t_i_t_l_e
  173.           This specifies the title of the graphical notification.  If a
  174.           numeric notification priority is set with -n, title defaults to:
  175.  
  176.                Priority 1 - "Critical System Error"
  177.                Priority 2 - "System Error"
  178.                Priority 3 - "System Warning"
  179.                Priority 4 - "System Information"
  180.  
  181.           If neither a title nor priority are specified the title will default
  182.           to:  "System information"   If a priority is specified, a custom
  183.           title can still be specified.
  184.  
  185.      The third synopsis is for sending a message to a specified pager.
  186.      _e_s_p_n_o_t_i_f_y uses _q_p_a_g_e (see _Q_u_i_c_k_P_a_g_e(1m) for more details) to deliver the
  187.      message. The QuickPage daemon must be running on the machine that
  188.      delivers the page.  This daemon is started during system startup if
  189.      chkconfig variable, quickpage is turned on.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  203.  
  204.  
  205.  
  206.      The configuration of the daemon can be done via SGI Embedded Support
  207.      Partner User Interface.  Please refer to the SGI Embedded Support Partner
  208.      User's Guide for more details.
  209.  
  210.      The options for paging notification include:
  211.  
  212.      ----CCCC _m_e_s_s_a_g_e
  213.           Specifies a text string for use as alphanumeric page content.  Text
  214.           must be contained within double quotes if spaces are needed in the
  215.           string. This option must be specified for paging notification to
  216.           work.
  217.  
  218.  
  219.      ----pppp _p_a_g_e_r_s
  220.           Comma separated list of pager or pager-ids that are to receive a
  221.           notification.  One or more  of each can be specified on the command
  222.           line.  Pager specifications are stored in /etc/qpage.cf file on the
  223.           server that is delivering the page.  The pagers can be set from the
  224.           SGI Embedded Support Partner User Interface.
  225.  
  226.  
  227.      ----SSSS _p_a_g_i_n_g _s_e_r_v_i_c_e
  228.           This options allows the specification of an alternate paging
  229.           service.  Service specifications are stored in /etc/qpage.cf file on
  230.           the server that is delivering the page.  These services can be set
  231.           from the SGI Embedded Support Partner User Interface.  If no service
  232.           is specified then the service with name set as 'default' is used to
  233.           deliver the page.
  234.  
  235.  
  236.      ----QQQQ _q_p_a_g_e _s_e_r_v_e_r
  237.           This option allows the specification of an alternate server on which
  238.           the QuickPage daemon is running.  If this option is not specified a
  239.           connection to the local Qpage daemon will be tried.
  240.  
  241.      The fourth synopsis is to display message on the terminal/system console.
  242.      The message specified with ----AAAA is displayed on the standard output of the
  243.      terminal if open.  Otherwise, the message is displayed on the system
  244.      console.
  245.  
  246.  
  247. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  248.      Send a prioritized GUI notification.
  249.  
  250.      % espnotify -n 2 -c "Widget 25 failure"
  251.  
  252.      Send a prioritized e-mail notification with string content along with a
  253.      page.  In this example we are using a "pager" definiton defined in
  254.      /etc/qpage.cf as the argument for the -p parameter.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  269.  
  270.  
  271.  
  272.      % espnotify -n 2 -E john@xyz.com -m "System disk is nearing capacity" -p
  273.      johndoe -C "System disk is nearing capacity"
  274.  
  275.      Send a page to "johndoe".  Use an alternate Qpage server along with an
  276.      alternate paging service.  "johndoe" along with the alternate paging
  277.      service name must exist in /etc/qpage.cf configuration file on the
  278.      alternate QuickPage Server.
  279.  
  280.      % espnotify -C "System temperature too high" -Q pager.server.com -S
  281.      airtouch -p johndoe
  282.  
  283. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  284.      Mail(1), QuickPage(1m), esp(5).
  285.  
  286. RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  287.      SGI Embedded Support Partner Documentation.
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.